/* 
 * File:   Finder.h
 * Author: vicror
 *
 * Created on October 21, 2011, 6:50 PM
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files
 * (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef FINDER_H
#define	FINDER_H

#include "Base_SearchEnginer.h"
#include "FinderItem.h"


namespace SearchEnginer {
    
    class Finder :public Base_SearchEnginer {
    public:
        Finder();
        Finder(const Base_SearchEnginer& orig);
        ~Finder();

        /**
         * @brief Ишет слово в словаре.
         * @param orig - слово
         * @return Возрашает индексы, для которых слово соответсвует поиску.
         */
        virtual ListIndex hasWordByID(const string& orig) const;

    protected:


        /**
         * @brief Добавление в словарь слова.
         * @param orig - слово
         * @param index - индекс в словаре
         *
         * При добавлении слова в словаре, данная функция вызывается
         * автоматически словарем. Нельзя ее применять напрямую.
         */
        virtual void syncWord(const string& orig, Index index);

        /**
         * @brief Функция предназначена для полной очистки словаря в дочерних
         * классах.
         * @param Нет входных параметров.
         * @return Нет возврашаемого значения.
         */
        virtual void OnClear(void);



        
    private:
        FinderItem root;

    };
}
#endif	/* FINDER_H */

